<!DOCTYPE html>
<html lang="en">
  <head>
    <title>NVActivityIndicatorViewable Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>

    <a name="//apple_ref/swift/Protocol/NVActivityIndicatorViewable" class="dashAnchor"></a>

    <a title="NVActivityIndicatorViewable Protocol Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../index.html">
          NVActivityIndicatorView Docs
        </a>
         (98% documented)
      </p>
    
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/ninjaprox/NVActivityIndicatorView">
            <img class="header-icon" src="../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../index.html">NVActivityIndicatorView Reference</a>
      <img class="carat" src="../img/carat.png" />
      NVActivityIndicatorViewable Protocol Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/ActivityData.html">ActivityData</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/NVActivityIndicatorPresenter.html">NVActivityIndicatorPresenter</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Classes/NVActivityIndicatorView.html">NVActivityIndicatorView</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Enums/NVActivityIndicatorType.html">NVActivityIndicatorType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Protocols/NVActivityIndicatorViewable.html">NVActivityIndicatorViewable</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:23NVActivityIndicatorView15FadeInAnimationa">FadeInAnimation</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../Typealiases.html#/s:23NVActivityIndicatorView16FadeOutAnimationa">FadeOutAnimation</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content">
            <h1>NVActivityIndicatorViewable</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">NVActivityIndicatorViewable</span></code></pre>

                </div>
              </div>
            <p>UIViewController conforms this protocol to be able to display NVActivityIndicatorView as UI blocker.</p>

<p>This extends abilities of UIViewController to display and remove UI blocker.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE11isAnimatingSbvp"></a>
                    <a name="//apple_ref/swift/Property/isAnimating" class="dashAnchor"></a>
                    <a class="token" href="#/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE11isAnimatingSbvp">isAnimating</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Current status of animation, read-only.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">isAnimating</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE14startAnimating_7message0I4Font4type5color7padding20displayTimeThreshold014minimumDisplayO015backgroundColor04textT015fadeInAnimationySo6CGSizeVSg_SSSgSo6UIFontCSgAA0aB4TypeOSgSo7UIColorCSg12CoreGraphics7CGFloatVSgSiSgA6_A1_A1_ySo0E0CcSgtF"></a>
                    <a name="//apple_ref/swift/Method/startAnimating(_:message:messageFont:type:color:padding:displayTimeThreshold:minimumDisplayTime:backgroundColor:textColor:fadeInAnimation:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE14startAnimating_7message0I4Font4type5color7padding20displayTimeThreshold014minimumDisplayO015backgroundColor04textT015fadeInAnimationySo6CGSizeVSg_SSSgSo6UIFontCSgAA0aB4TypeOSgSo7UIColorCSg12CoreGraphics7CGFloatVSgSiSgA6_A1_A1_ySo0E0CcSgtF">startAnimating(_:message:messageFont:type:color:padding:displayTimeThreshold:minimumDisplayTime:backgroundColor:textColor:fadeInAnimation:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Display UI blocker.</p>

<p>Appropriate NVActivityIndicatorView.DEFAULT_* values are used for omitted params.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">startAnimating</span><span class="p">(</span>
    <span class="n">_</span> <span class="nv">size</span><span class="p">:</span> <span class="kt">CGSize</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">messageFont</span><span class="p">:</span> <span class="kt">UIFont</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/NVActivityIndicatorType.html">NVActivityIndicatorType</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">color</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">padding</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">displayTimeThreshold</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">minimumDisplayTime</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">textColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    <span class="nv">fadeInAnimation</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:23NVActivityIndicatorView15FadeInAnimationa">FadeInAnimation</a></span><span class="p">?</span> <span class="o">=</span> <span class="kt"><a href="../Classes/NVActivityIndicatorView.html">NVActivityIndicatorView</a></span><span class="o">.</span><span class="kt">DEFAULT_FADE_IN_ANIMATION</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>size</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>size of activity indicator view.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>message</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>message displayed under activity indicator view.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>messageFont</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>font of message displayed under activity indicator view.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>type</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>animation type.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>color</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>color of activity indicator view.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>padding</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>padding of activity indicator view.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>displayTimeThreshold</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>display time threshold to actually display UI blocker.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>minimumDisplayTime</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>minimum display time of UI blocker.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>fadeInAnimation</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>fade in animation.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE13stopAnimatingyyySo0E0C_yyctcSgF"></a>
                    <a name="//apple_ref/swift/Method/stopAnimating(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:23NVActivityIndicatorView0aB8ViewablePAASo16UIViewControllerCRbzrlE13stopAnimatingyyySo0E0C_yyctcSgF">stopAnimating(_:)</a>
                    </code>
                      <span class="declaration-note">
                        Extension method
                      </span>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Remove UI blocker.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stopAnimating</span><span class="p">(</span><span class="n">_</span> <span class="nv">fadeOutAnimation</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:23NVActivityIndicatorView16FadeOutAnimationa">FadeOutAnimation</a></span><span class="p">?</span> <span class="o">=</span> <span class="kt"><a href="../Classes/NVActivityIndicatorView.html">NVActivityIndicatorView</a></span><span class="o">.</span><span class="kt">DEFAULT_FADE_OUT_ANIMATION</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>fadeOutAnimation</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>fade out animation.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2018 <a class="link" href="https://github.com/ninjaprox" target="_blank" rel="external">Vinh Nguyen</a>. All rights reserved. (Last updated: 2018-12-18)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
